.. _createCharScreen Functions:

==========================
createCharScreen Functions
==========================

.. toctree::
   :maxdepth: 1
   :hidden:
   :glob:

   createCharScreen_*

.. note:: The **createCharScreen** functions are related to the handling of character generation

+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| **Function**                                                                                                          | **Description**                                            |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:AcceptCharacter<createCharScreen_AcceptCharacter>`                                            |                                                            |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:DecCurrentPortrait<createCharScreen_DecCurrentPortrait>`                                      | Decrement the current portrait selection for character     |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:GetCurrentPortrait<createCharScreen_GetCurrentPortrait>`                                      | Returns the current portrait set for the character         |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:GetCurrentStep<createCharScreen_GetCurrentStep>`                                              | Returns current stage of the character generation          |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:GetEngineState<createCharScreen_GetEngineState>`                                              | Get the character creation engine state                    |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:GetImportState<createCharScreen_GetImportState>`                                              |                                                            |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:GetImportableCharacters<createCharScreen_GetImportableCharacters>`                            | Returns a list of character that can be imported           |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:HasMoreMageLevels<createCharScreen_HasMoreMageLevels>`                                        |                                                            |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:IncCurrentPortrait<createCharScreen_IncCurrentPortrait>`                                      | Increment the current portrait selected for character      |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:IsAbilityRecallButtonClickable<createCharScreen_IsAbilityRecallButtonClickable>`              | Determines if **Recall** button is clickable               |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:IsAdvancedButtonClickable<createCharScreen_IsAdvancedButtonClickable>`                        | Determines if **Advanced** button is clickable             |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:IsChargenComplete<createCharScreen_IsChargenComplete>`                                        | Determines if character generation is complete             |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:IsDoneButtonClickable<createCharScreen_IsDoneButtonClickable>`                                | Determines if **Done** button is clickable                 |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:IsHighLevelAbilitiesButtonClickable<createCharScreen_IsHighLevelAbilitiesButtonClickable>`    | Determines if HLA button is clickable                      |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:IsMainBackButtonClickable<createCharScreen_IsMainBackButtonClickable>`                        | Determines if main screen Back button is clickable         |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:IsThiefSkillPlusMinusButtonClickable<createCharScreen_IsThiefSkillPlusMinusButtonClickable>`  | Determines if Thief **+** or **-** buttons are clickable   |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnAbilityPlusMinusButtonClick<createCharScreen_OnAbilityPlusMinusButtonClick>`                | Event action when ability + and - buttons clicked          |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnAbilityReRollButtonClick<createCharScreen_OnAbilityReRollButtonClick>`                      | Event action when **Reroll** button is clicked             |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnAbilityRecallButtonClick<createCharScreen_OnAbilityRecallButtonClick>`                      | Event action when **Recall** button is clicked             |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnAbilityStoreButtonClick<createCharScreen_OnAbilityStoreButtonClick>`                        | Event action when **Store** button is clicked              |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnAdvancedButtonClick<createCharScreen_OnAdvancedButtonClick>`                                | Event action when **Advanced** button is clicked           |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnAlignmentSelectButtonClick<createCharScreen_OnAlignmentSelectButtonClick>`                  | Event action when an alignment is selected                 |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnBiographyButtonClick<createCharScreen_OnBiographyButtonClick>`                              | Event action when **Biography** button is clicked          |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnCancelButtonClick<createCharScreen_OnCancelButtonClick>`                                    | Event action when **Cancel** button is clicked             |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnCharacterExportItemSelect<createCharScreen_OnCharacterExportItemSelect>`                    | Event action when **Export** Item button is clicked        |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnCheatyMcCheaterson<createCharScreen_OnCheatyMcCheaterson>`                                  | Event action when CTRL+8 cheat keys are pressed            |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnClassSelectButtonClick<createCharScreen_OnClassSelectButtonClick>`                          | Event action when a class button is selected               |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnDoneButtonClick<createCharScreen_OnDoneButtonClick>`                                        | Event action when **Done** button is clicked               |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnGenderSelectButtonClick<createCharScreen_OnGenderSelectButtonClick>`                        | Event action when a gender button is selected              |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnHLAButtonClick<createCharScreen_OnHLAButtonClick>`                                          | Event action when HLA button is clicked                    |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnHighLevelAbilitiesButtonClick<createCharScreen_OnHighLevelAbilitiesButtonClick>`            | Event action when a HLA ability button is clicked          |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnImportCharacterButtonClick<createCharScreen_OnImportCharacterButtonClick>`                  | Event action when **Import** Char button is clicked        |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnImportCharacterFileButtonClick<createCharScreen_OnImportCharacterFileButtonClick>`          | Event action when import file button is clicked            |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnImportSaveButtonClick<createCharScreen_OnImportSaveButtonClick>`                            | Event action when import **Save** button is clicked        |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnKitSelectButtonClick<createCharScreen_OnKitSelectButtonClick>`                              | Event action when a kit is selected                        |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnLearnMageSpellButtonClick<createCharScreen_OnLearnMageSpellButtonClick>`                    | Event action when a mage learn spell button is clicked     |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnMainBackButtonClick<createCharScreen_OnMainBackButtonClick>`                                | Event action when main **Back** button is clicked          |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnMainCancelButtonClick<createCharScreen_OnMainCancelButtonClick>`                            | Event action when main **Cancel** button is clicked        |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnMemorizeMageSpellButtonClick<createCharScreen_OnMemorizeMageSpellButtonClick>`              | Event action when a mage spell button is clicked           |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnMemorizePriestSpellButtonClick<createCharScreen_OnMemorizePriestSpellButtonClick>`          | Event action when a priest spell button is clicked         |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnMenuButtonClick<createCharScreen_OnMenuButtonClick>`                                        | Event action when a menu button is clicked                 |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnPlayButtonClick<createCharScreen_OnPlayButtonClick>`                                        | Event action when **Play** button is clicked               |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnPrerollCancelButtonClick<createCharScreen_OnPrerollCancelButtonClick>`                      | Event action when preroll Cancel button is clicked         |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnPrerollCharacterPick<createCharScreen_OnPrerollCharacterPick>`                              | Event action when preroll character is selected            |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnProficiencyPlusMinusButtonClick<createCharScreen_OnProficiencyPlusMinusButtonClick>`        | Event action when proficiency **+** or **-** button clicked|
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnRaceSelectButtonClick<createCharScreen_OnRaceSelectButtonClick>`                            | Event action when a race is selected                       |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnRacialEnemySelectButtonClick<createCharScreen_OnRacialEnemySelectButtonClick>`              | Event action when a hated race is selected                 |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnSoundItemSelect<createCharScreen_OnSoundItemSelect>`                                        | Event action when a soundset item is selected              |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:OnThiefSkillPlusMinusButtonClick<createCharScreen_OnThiefSkillPlusMinusButtonClick>`          | Event action when thief skill **+** or **-** button clicked|
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:SetAbilityHelpInfo<createCharScreen_SetAbilityHelpInfo>`                                      | Set tokens for ability score information                   |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:SetEngineState<createCharScreen_SetEngineState>`                                              | Set the character creation engine state                    |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:SetSpriteId<createCharScreen_SetSpriteId>`                                                    | Set the paperdoll and avatar for character                 |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| :ref:`createCharScreen\:ShowPortraitPanel<createCharScreen_ShowPortraitPanel>`                                        | Show portrait selection panel                              |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+


::

   e = g_pBaldurChitin
   createCharScreen = e:GetEngineCreateChar()